Software Vault: The Diamond Collection/The Diamond Collection (Software Vault)(Digital Impact).ISO/cdr38/tvpm20.zip/VGAPMAN.DOC

Text File | 1995-04-04 | 23KB | 473 lines

                    ┌──────────────────────────────────────┐
                    │░░░  TBBS VGA PLANETS MANAGER 2.0  ░░░│
                    └──────────────────────────────────────┘
                            (C) 1995 Gary Yaroslaski

┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  OVERVIEW  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

TBBS VGA Planets Manager is an interface for VGA Planets 3.0 Players and a
multiple game configuration utility for Sysops using a TBBS 2.x BBS and
TDBS 1.2.  TBBS VGA Planets Manager 2.0 will be referred to as VGAPMAN for the
rest of this document.

VGA Planets 3.0 is written by Tim Wisseman.  If you have never heard of this
game, you should get a copy and try it out.  The game's depth and involvement
is much too great to get into in this document.  Basically, you wouldn't have
downloaded this file if you didn't already know what it was.

This documentation is not going to show you how to setup VGA Planets, that's
what your VGA Planets documentation is for.  This documentation will only show
you how to setup, configure and run TBBS VGA Planets Manager 2.0.

The whole problem to running VGA Planets is you must "Host" the game in
DOS mode.  For TBBS sysops that's an impossibility while their system is up,
so the games must be hosted when the BBS comes down for mail tossing or
system maintenance.  Other problems are:  how do make sure the right player
gets the right turn, when do you Host, HOW do you Host, how do you let the
user know his turn is ready, how do you schedule multiple games?  VGAPMAN
solves these problems by writing the batch files necessary to execute
multiple games automatically and has a secure method for users to upload and
download turns.


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  FEATURES  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

New in version 2.0:
 - Able to set minimum number of players to start a game (Enrollment mode)
 - Allows players to withdraw from a game
 - Able to set number of missed turns until a player expires
 - Automatic startup of Cplayer (Sysop configurable) once a player expires

Version 1.0:
 - Simple, informative, easy-to-use interface and uncomplicated game setup
 - Up to nine games can be run concurrently
 - Start managing games already in progress
 - On-line Sysop configuring
 - Writes .BAT files (ghost events) for unattended operation
 - Writes .BAT files for manual Hosting
 - Displays players password (IF CRACK.EXE exists)
 - Able to create .BAT files early for running Host ahead of schedule
 - Host and game location can exist on different drives
 - Automated and secure uploading and downloading of player files
 - Sysop can change/reserve race slots
 - Game planning, enrollment, playing and finished modes
 - Cplayer and Referee compatibility
 - Co-sysop privilege level configurable
 - Detects races that are not configured and being played
 - Game status, turn status, player comments, turn number
 - Allows player to upload over existing .TRN file
 - Improved score display with totals
 - Players can play more than one race
 - Allows players to enter taunting descriptions for their .TRN file
 - Sysop on-line viewing of standard log files
 - Runs on a single computer


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  REQUIREMENTS  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

DOS 5.0 or greater
TBBS 2.2M or greater
TDBS 1.2
VGA Planets 3.0
(only) one computer


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  UPGRADING FROM A PREVIOUS VERSION  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

Upgrading from version 1.0 to version 2.0 is free.

These instructions only pertain to those Sysops that are upgrading from
VGAPMAN 1.0 to 2.0.

If you are installing version 2.0 for the first time, the file UPGRADE.EXE
may be deleted from the VGAPMAN directory.  No changes are necessary to
upgrade the 2.0 databases.

To upgrade the 1.0 databases to the new 2.0 version, the following steps need
to be performed correctly to ensure compatibility with the new code.

1.  Unzip the TVPM20.ZIP file into the directory where VGAPMAN 1.0 is
    installed, overwriting all files.  This will update the VGAPMAN database
    structures.  This process will not overwrite the game.dbfs so do not be
    alarmed.  Care must be taken not to delete the game.dbfs.

2.  Run the UPGRADE.EXE utility.  This program will upgrade all existing
    game.dbfs.

3.  Enter the VGAPMAN directory when the upgrade program asks for the
    location.  Once a valid directory is entered, the program will update all
    of the game files to the new version.

The upgrade process is now complete.  UPGRADE.EXE can now be deleted from the
VGAPMAN directory to conserve hard drive space.


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  INSTALLATION/SETUP  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

Please read this carefully.  You don't want to see a VGA Planets Player
mad at turn 72!!!

VGAPMAN is meant to be utilized with Tim Wisseman's VGA Planets 3.0.  VGAPMAN
expects to find all the VGA Planets files in one location.  This includes the
HOST.EXE, CPLAYER.EXE, REF.EXE and CRACK.EXE programs along with all the
support files (I.E.: *.DAT).  If you have installed VGA Planets from the
installer program that came with VGA Planets, you should not have any
problems.  CRACK.EXE must be available in the Host directory for the players
to view their passwords.  If you do not have CRACK.EXE in the Host directory,
VGAPMAN will not run the crack utility and the passwords will not be available
for viewing on-line.  CRACK.EXE is a third party utility that may be obtained
from the VGA Planets support BBS.

VGAPMAN requires ANSI and IBM graphics to be enabled for the user.  If a user
does not have ANSI flag set, VGAPMAN will ask the user if he wishes to toggle
this flag on and set it appropriately.

VGAPMAN can make the hosting of VGA Planets totally automatic once a game is
setup.  Therefore, it is very important that all aspects of installation are
completed correctly.  Otherwise disastrous things can happen to recently
created games or games already in progress.  Timing is very critical in the
execution of events for VGAPMAN.

VGAPMAN expects that since you are running VGA Planets, you are taking your
BBS down at least once per day for running the HOST.EXE program.


1.  Install VGA Planets in a directory by itself.  IE: C:\PLANETS

2.  At this time, you may want to create a game directory,
    I.E. C:\PLANETS\GAME1. Then Master, Hconfig and Host a game in the
    specified directory.

3.  Most TDBS applications operate best when placed in a directory by
    themselves.  Unzip all the VGAPMAN files into a directory by
    itself.  IE: C:\TBBS\VGAPMAN

4.  Put an option in one of your menus to call VGAPMAN.  An example is as
    follows:

    entry: key=v type=200 opt data=c:\tbbs\vgapman\vgapman -p200 /q

    The -p is the minimum privilege level of your co-sysop that is needed to
    access the Sysop Control Panel in VGAPMAN.  BE VERY CAREFUL.  All users
    above this privilege level can access the Sysop Control Panel, and this
    allows major aspects of game operation to be changed.

    If the -p is omitted on the command line, then only privilege level 255
    can access the Sysop Control Panel.

5.  You must add a ghost event through CEDIT.  Be sure to include the -g
    option on the command line.  This instructs VGAPMAN to check for games
    that need to be hosted.  An example is as follows:

    Event 1, Occurs on Line 254 at 00:05 on Sun, Mon, Tue, Wed, Thu, Fri, Sat
             Type = 200  OptData = c:\tbbs\vgapman\vgapman -g/q

    The time (00:05) is what time the ghost event will run.

    IMPORTANT:  The event MUST be ran ONCE per day.
                The event MUST be ran BEFORE the system is brought down.

    The ghost event should be ran as the first item for the day.
    (I.E.: 12:05am)  This insures that all data is up to date on all your
    games prior to being utilized for that day.

6.  Add these two lines to your RUNBBS.BAT file BEFORE your MLTBBS.EXE line
    in your recycle loop.  An example is as follows:

    :recycle

->  if exists c:\planets\hostrun.bat call c:\planets\hostrun.bat
->  if exists c:\planets\hostrun.bat del c:\planets\hostrun.bat

    mltbbs /6 /OX:tdbsom,sysom

    Of course, change the appropriate directory names to where your VGA
    Planets files are located.

6.  VGAPMAN is now setup.  See the next section to setup and configure a game.


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  OPERATION  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

The main menu is where access to all the games happen.  The menu presents a
listing of up to nine games simultaneously.  Each game will have essential
statistics including:  turn number, game status (planning, enrollment,
playing or finished), game start date and next hosting date.  There are two
modes of operation.

User Mode

If a user simply selects a game number that they are participating in, they
will be presented with the Player Status screen.  This screen shows all of the
game statistics along with all of the races that are participating in the
game.  Each race is displayed with the upload/download status of the turn and
any comments a player might leave.  The user may [U]pload a .TRN and
[D]ownload a .RST.  Users are allowed to overwrite turns that exist (in case
they upload a wrong or stale .TRN).  When a user uploads a turn, he may leave
a message for all other players to see when they also upload their .TRN.  If a
user is playing more than one race, he will be prompted to upload/download
each .TRN or .RST file.  The default protocol for uploading and downloading is
Zmodem.  This is to be consistent with the VGA Planets documentation.  The
[V]iew Score option displays a reformatted score.log with planets, starbases
and ship totals.  If the game has any races that are available, a user may
join the game by [S]electing a valid race.  A user will not be able to
download his turn in the Enrollment mode until the game has begun in the
Playing mode.  A user may [W]ithdraw at anytime.  New users picking up an .RST
previously played or have forgotten their password, may press [P]assword to
view the current .RST password.

Sysop Mode

A Sysop (privilege level=255) or Co-sysop with the appropriate privilege
level, as specified on the Opt Data command line, can press the "S" to enter
Sysop mode.  This is were you setup and modify games.  THE FIRST TIME the "S"
key is selected by a Sysop, VGAPMAN will ask for the location of the
RUNBBS.BAT file and the location of the VGA Planets HOST.EXE file.  Once these
locations have been setup, they can be changed at any time on the Sysop
Control Panel screen.  From this time on, pressing the "S" key will prompt the
Sysop for which game number to edit.  If a game number does not exist, a new
game slot is created and is automatically placed into Planning mode.  Now
proceed to fill in the blanks to configure this game.

Game Directory - Enter the game directory where this particular game exists
(I.E. C:\PLANETS\GAME1).  If the game exists (has been Mastered and Hosted),
VGAPMAN will display what races have been selected.  If the game directory
field is left blank, then a game is assumed to be in the Planning mode.

Game Number - An descriptive field that displays the current game number.

Description - A short description should be entered so the users can tell the
difference between multiple games.

Turn Number - If a game is in progress, the turn number is automatically
updated.

Status - There are four status modes for the VGAPMAN:  Planning, Enrollment,
Playing and Finished.  In the Planning mode, anything goes.  The game
directory does not even have to exist in the Planning mode.  The game does not
have to be Mastered or Hosted yet (more on this later).  In the Playing mode,
the game MUST HAVE BEEN at least Mastered and Hosted.  You may have also
Hconfiged and Rconfiged it.  In the Enrollment mode, users are allowed to join
the game at will by selecting the desired race.  The game will start when the
minimum number of players setting has been satisfied.  The Finished mode
allows a method of leaving the old games there for your war heroes to view for
a while... Until Game 10 starts!

Cplayer - This is if you want to limit Cplayer to tech 7 for all races where
CPLAYER is the User Name.  Otherwise, Cplayer will be limited to Tech 10.

Ref - If you are running Ref, you must have ran the Rconfig utility that comes
with VGA Planets.  This option specifies whether or not to run the Referee
program on the game.

Num Players - This is only for games that are in Enrollment mode.  The game
will automatically switch to Playing mode when the number of races being
played by the users and/or Cplayer equal this number.

Missed Turns - This is the minimum number of turns in a row that must be
missed by a player before Cplayer is turned on for this race.  A value of zero
means never turn on Cplayer.

Start Date - Start date is when the game started, not necessarily when the
first Host will run.  This date is what the Host run frequency is based on.
This is handy for advertising games in Planning mode.

Frequency - Select the frequency for the Host run.  Check this chart.

 1 = run Host once every day
 2 = every other day
 3 = every third day
 4 = every fourth day
 5 = every fifth day
 6 = every sixth day
 7 = every seventh day (this would be once a week)
 8 = Monday, Wednesday, Friday
 9 = Sunday, Tuesday, Thursday

Next Host Run - Based on the frequency you just chose, the next Host run date
will update accordingly.  You can manually adjust this field for custom
Hosting or for any system down time that may have affected the users upload
and download schedules.

Next you must enter the user name for each race.  In Planning mode, anything
can be put in this field (more than one name).  When the game is switched to
playing mode, it is VERY IMPORTANT that the user names be exactly as in your
USERLOG.BBS.  Otherwise, the user will not be able to even access the game,
much less upload or download a turn.  CPLAYER must be entered as the user name
for a race that will be played by Cplayer.

Once all of this information is entered, the Sysop will have a small menu at
the bottom of the screen.  The options are as follows:

[G]lobal Directory edit will allow the Sysop to change where the location of
his RUNBBS.BAT and HOST.EXE files exist.

[D]elete Current Game does just what it says... VGAPMAN will forget everything
it knows about the current game.

[C]reate HOSTRUN.BAT allows the Sysop to create a batch for Hosting right
on the spot.  Use this very carefully.  You will have the option to affect
the date.  In other words, you can keep the game right on schedule and get
an extra turn in or get the next date according to the game frequency.  You
must down the BBS and bring it back up again for the Host to run.  (Our Sysop
uses it to Host turns early if all users have uploaded early and have been
pestering the Sysop to run the Host early.)

[M]odify fields takes you through all the fields again so you can add, update,
or change game info.

[V]iew logs allows you to view the host.log or error.log and ref.log files if
they exist.


NOW...  WHAT WILL HAPPEN is the ghost will run at 12:05 on a new day.  The
event will create all the batch files necessary to run all the VGA Planets
games that need to be hosted for that day.  Then your BBS comes down for
system maintenance or tossing mail some time after that (an hour or two).  On
the way back up, all of the scheduled VGA Planets games for that day will be
Hosted.  All the necessary databases will be updated.

Remember that time and the schedule of events is important.  If modifications
are being done at 12:06am, such as adding a new game, it won't be checked for
a Host run until the next day.

For all you techies - VGAPMAN creates flag files in the Host directory and
obviously .dbf files in the VGAPMAN directory.  DO NOT KILL, MAIM OR MANGLE
these files.  Or else the Host will not run and the users will kill, maim or
mangle you! :)


Real-time Applications  (Real life experiences)

1)  What our Sysop (me) was always doing for new games was advertising a new
game of VGA Planets and asking each user to select their top 5 race picks.
What he had to do then was write each person's name down and their 5 races.
What Planning mode allows to be done is use the VGAPMAN as a scratch pad until
a Sysop determines who is going to play what race and who is going to drop
out.  Now, when the races have been decided upon permanently, the Sysop simply
Masters and Hosts the game with the real races, enters the real names of the
users, puts the game in Playing mode, and updates the Next Host Run date.  Now
it is off and running.  He doesn't have to look at the game again until its
finished.

2)  We had been playing for three months and everybody wanted to take off two
weeks for vacation and not miss a turn.  By modifying the Next Host Run date
from 12/24/94 to 01/03/95, none of our players missed a single turn and were
able to enjoy Christmas knowing everything was safe and sound at the Echo Star
Cluster.

3)  Our Sysop was creating, running, and managing files by hand.  When players
dropped out and new ones took over, our Sysop had file directories and
password .QALs to update (that looked bad).  VGAPMAN does it all
automatically.  Now he is free to clean up the file areas!


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  EVALUATION/REGISTERED VERSIONS  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

VGAPMAN is protected from unauthorized copying and use by means of a system
"key" file.  When a key file is purchased from Gary's Automated Software
Solutions, your single copy of VGAPMAN is then considered to have been
upgraded to the registered version of the software.  Until that time, it
remains the evaluation version of software.  While the evaluation version is
fully functional, it does incorporate two basic limitations.  It will only
allow one game to be configured and played and only up to turn 10.  You and
your users should have figured out whether or not you find this software
useful by that time.

When you have purchased a key, simply place the key in your VGAPMAN directory
and VGAPMAN will find it.


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  PROBLEMS/ERRORS  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

Please report any errors, comments, or enhancements to:

Internet:  [e-mail]
 Fidonet:  Gary Yaroslaski @ 1:102/1326
     BBS:  Metropolis [phone] - Send Private E-mail to Gary Yaroslaski


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  ORDERING  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

TBBS VGA Planets Manager 2.0      $39.95

CA residents please add appropriate sales tax.

Please fill out the order form included in this package (REGISTER.FRM) and
send it with either check or money order to:  Gary Yaroslaski
                                              43821 Beech Avenue
                                              Lancaster, CA  93534


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  NEXT VERSION  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

Possible additions for the next version:

 - support for VGA Planets 3.5 and Q
 - bulletins manager for games in Planning and Enrollment modes
 - messaging via TBBS 2.3 features
 - configurable colors
 - team uploading/downloading
 - team scores

Please e-mail any enhancements or suggestions you may have to include in the
next version.


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  CREDITS  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

Programming: Gary Yaroslaski
     Design: Gary Yaroslaski, Mike Johns, Todd Yaroslaski
  Beta Team: Gary Yaroslaski, Mike Johns, Todd Yaroslaski, Wayne Patrick
       Docs: Mike Johns ([e-mail])
Support BBS: Metropolis [phone] 28.8K V.34
VGA Planets: Tim Wisseman


┌─────────────────────────────────────────────────────────────────────────────┐
│░░░  LEGAL  ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────────────────────────┘

This software is provided without any guarantee or warranty either expressed
or implied.  Gary's Automated Software Solutions will not be held responsible
for ANY damages that may result from the use of this program.

This program (VGAPMAN) and all related databases are covered by national and
international copyright laws for intellectual property and may not be modified
in any way without prior written permission directly from Gary's Automated
Software Solutions.  This includes, but is not limited to, decompiling or
reverse engineering, or bit editing of programs, data, or text files, or any
form of direct or indirect modification not performed by the program itself.

This software is not public domain or shareware.  You are allowed to make a
personal backup copy as long as there is never a chance of this software
running on more than one cpu per paid license.  Evaluation copies of this
software are made available only to allow you to verify the functionality and
quality.  They are not intended to provide you with a free program.

Gary's Automated Software Solutions reserves the right to modify this
agreement and/or the VGAPMAN software at any time without warning or prior
notice.